home *** CD-ROM | disk | FTP | other *** search
/ PCGUIA 2010 Software/Programs / PCGuia_programas.iso / Software / Utils / Find and Run Robot / FindAndRunRobotSetup.exe / Plugins / ExternalSearch / readme.txt < prev   
Encoding:
Text File  |  2007-08-06  |  3.4 KB  |  68 lines

  1. ------------------------------------------------------------------------
  2. ExternalSearch - v1.0.0.0 (July 17th, 2007)
  3. by Ehtyar Holmes
  4. Copyleft 2007 - No rights reserved.
  5. ------------------------------------------------------------------------
  6.  
  7.   * This package contains the plug-in only, and is for users of applications
  8.     that utilise FARR via the ExternalSearch plug-in. Developers should
  9.     download the plug-in with its sources and documentation, found in
  10.     ExternalSearchSrc.zip located in the same directory as was this archive.
  11.  
  12.   * This plug-in is designed to facilitate, in a very basic way, integration 
  13.     of external applications with the searching capabilities of FARR. It is 
  14.     designed with programmers in mind to allow for quick and painless 
  15.     integration. With it, you can instruct FARR to perform searches on
  16.     your application's behalf with a string you specify, via the FARRT
  17.     library (yes this name is a joke).
  18.     
  19.   * The plug-in comes as follows:
  20.     - ExternalSearch containing the ExternalSearch FARR plug-in and its 
  21.     source.
  22.     - FARRT containing the dll which can be used to interface with FARR
  23.     in order to perform searches.
  24.     - ExternalSearchTest containing a demonstration program showing how
  25.     to use the FARRT dll to interface with FARR. NOTE: If you wish to make 
  26.     use of this demonstration program, you will need to copy the FARRT dll
  27.     to the same directory.
  28.     NOTE: The plug-in does not come with any project files of any kind, as
  29.     I do not use an IDE. If you wish to build this plug-in yourself, 
  30.     you will need to create project files for use with your IDE, I cannot
  31.     and will not help you with this.
  32.     
  33.   * The FARRT dll exports a single function, FarrSearch, which takes a single
  34.     parameter, a search string: BOOL FarrSearch(LPSTR lpSearchString). The 
  35.     function will return TRUE (1) on a successful search, and FALSE (0) on an
  36.     unsuccessful search (usually indicating FARR is not running. FarrSearch uses
  37.     the cdecl ("C") calling convention (caller is responsible for popping arguments
  38.     off the stack.
  39.     
  40.   * There are no options whatsoever for this plug-in as of version 1.0.0.0. If you
  41.     don't wish to use it, you may remove it from your plug-in directory.
  42.   
  43.   * I (Ehtyar) am not responsible for providing any kind of support in regards
  44.     to the use of the FARRT library. I am, however, responsible for the official 
  45.     maintenance of the ExternalSearch plug-in, and any bug reports can be filed
  46.     in the plug-ins forum thread at http://www.donationcoder.com/.
  47.     
  48.   * EXTERNALSEARCH IS DISTRIBUTED "AS IS".  NO WARRANTY OF ANY KIND IS
  49.     EXPRESSED OR IMPLIED.  YOU USE AT YOUR OWN RISK. THE AUTHOR WILL NOT BE
  50.     LIABLE FOR DATA LOSS, DAMAGES, LOSS OF PROFITS OR ANY OTHER KIND OF LOSS
  51.     WHILE USING OR MISUSING THIS SOFTWARE.
  52.  
  53.   * Requirements | The FindAndRunRobot version 2.0 and above.
  54.  
  55.   * Description  | Allows basic integration of third-party applications with the
  56.     FindAndRunRobot by Mouser at 
  57.     http://www.donationcoder.com/Software/Mouser/findrun/index.html.
  58.  
  59.   * The lack of copyright is intentional, as i have no qualms about you 
  60.     using/modifying the source code for the benefit of FindAndRun users or yourself.
  61.     Please feel free to use the source code instead of the FARRT library, it was
  62.     created only for ease of use.
  63.  
  64.   * Thanks:
  65.     Mouse Man: For the awesomeness that is FARR, and his invaluable help in the
  66.     creation of this plug-in
  67.     hamradio: For his permission to bootleg his readme.
  68.